Skip to content

Add report and CSV to SWY outputs list#224

Merged
megannissel merged 3 commits intonatcap:release/3.19.0from
megannissel:feature/223-swy-report
Apr 7, 2026
Merged

Add report and CSV to SWY outputs list#224
megannissel merged 3 commits intonatcap:release/3.19.0from
megannissel:feature/223-swy-report

Conversation

@megannissel
Copy link
Copy Markdown
Contributor

Resolves #223

This PR makes several updates to the model outputs list:

  • Adds the report, following the same description format used for Carbon, CV, SDR, and NDR.
  • Adds the new monthly average quickflow, baseflow, and precipitation CSV, along with documentation of the columns included therein
  • Adds the new geom_id field to aggregated_results_swy.shp
  • Updates the units for many of the model outputs to reflect the temporal dimension (either per year or per month)

Additionally:

  • Updates the underline style for the "Interpreting Results" headings (table of contents was missing direct links to those sections)

Outstanding questions:

  • Do we want to provide a more in-depth explanation of how the monthly baseflow, quickflow, and precip values included in the new CSV are calculated? If so, where / how?
  • Do we want to change / update our guidelines related to treating quickflow and baseflow as relative values / using them in calibration?

This was referenced Mar 23, 2026
@megannissel megannissel changed the base branch from main to release/3.19.0 March 31, 2026 16:19
@megannissel megannissel marked this pull request as ready for review April 7, 2026 14:49
Comment thread source/en/seasonal_water_yield.rst Outdated

* **vri_sum** (units: mm/year): total recharge contribution (positive or negative) within the watershed. The sum of ``Vri_[Suffix].tif`` pixel values within the watershed.

* **geom_id**: a unique ID for the watershed
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **geom_id**: a unique ID for the watershed
* **geom_id**: a unique ID for the watershed
``` * **geom_id**: a unique identification (ID) number for the watershed
Several other similar places just show "geom_id" and then "ID" in the description, with no explanation of what "id" means, so i suggest adding the explicit description at least here, then we can just use the abbreviation in the description in subsequent mentions. It might be obvious to many of us, but not necessarily people who are not native english speakers.

Copy link
Copy Markdown
Contributor

@newtpatrol newtpatrol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me @megannissel, i just added one small suggestion.

Copy link
Copy Markdown
Member

@jagoldstein jagoldstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! If anything else comes up, we can always adjust it later.

@megannissel megannissel merged commit 541d567 into natcap:release/3.19.0 Apr 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update SWY docs to accompany new report

3 participants